---
layout: m1x_soap
title: Product Info
---


<h2><a name="catalog_product.info-Module%3AMageCatalog"></a>Module: Mage_Catalog</h2>


<h4><a name="catalog_product.info-Resource%3Acatalogproduct"></a>Resource: catalog_product</h4>

<p><b>Aliases:</b></p>
<ul>
	<li>product</li>
</ul>


<h5><a name="catalog_product.info-Method%3A"></a>Method:</h5>

<ul>
	<li>catalog_product.info (SOAP V1)</li>
	<li>catalogProductInfo (SOAP V2)</li>
</ul>


<p>Allows you to retrieve information about the required product.</p>

<p><b>Aliases:</b></p>
<ul>
	<li>product.info</li>
</ul>



<p><b>Arguments:</b></p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description <br class="atl-forced-newline" /> </th>
</tr>
<tr>
<td> string </td>
<td> sessionId </td>
<td> Session ID </td>
</tr>
<tr>
<td> string </td>
<td> productId </td>
<td> Product ID or SKU </td>
</tr>
<tr>
<td> string </td>
<td> storeView </td>
<td> Store view ID or code (optional) </td>
</tr>
<tr>
<td> array </td>
<td> attributes </td>
<td> Array of catalogProductRequestAttributes (optional) </td>
</tr>
<tr>
<td> string </td>
<td> identifierType </td>
<td> Defines whether the product ID or SKU value is passed in the "productId" parameter. (optional) </td>
</tr>
</tbody></table>


<p><b>Returns</b>:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> array </td>
<td> info </td>
<td> Array of catalogProductReturnEntity </td>
</tr>
</tbody></table>


<p>The <b>catalogProductRequestAttributes</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> ArrayOfString <br class="atl-forced-newline" /> </td>
<td> attributes <br class="atl-forced-newline" /> </td>
<td> Array of attributes </td>
</tr>
<tr>
<td> ArrayOfString <br class="atl-forced-newline" /> </td>
<td> additional_attributes <br class="atl-forced-newline" /> </td>
<td> Array of additional attributes </td>
</tr>
</tbody></table>


<p>The <b>catalogProductReturnEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> product_id <br class="atl-forced-newline" /> </td>
<td> Product ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> sku <br class="atl-forced-newline" /> </td>
<td> Product SKU </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> set <br class="atl-forced-newline" /> </td>
<td> Product set </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> type <br class="atl-forced-newline" /> </td>
<td> Product type </td>
</tr>
<tr>
<td> ArrayOfString </td>
<td> categories <br class="atl-forced-newline" /> </td>
<td> Array of categories </td>
</tr>
<tr>
<td> ArrayOfString </td>
<td> websites <br class="atl-forced-newline" /> </td>
<td> Array of websites </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> created_at <br class="atl-forced-newline" /> </td>
<td> Date when the product was created </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> updated_at <br class="atl-forced-newline" /> </td>
<td> Date when the product was last updated </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> type_id <br class="atl-forced-newline" /> </td>
<td> Type ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> name <br class="atl-forced-newline" /> </td>
<td> Product name </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> description <br class="atl-forced-newline" /> </td>
<td> Product description </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> short_description <br class="atl-forced-newline" /> </td>
<td> Short description for a product </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> weight <br class="atl-forced-newline" /> </td>
<td> Product weight </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> status <br class="atl-forced-newline" /> </td>
<td> Status of a product </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> url_key <br class="atl-forced-newline" /> </td>
<td> Relative URL path that can be entered in place of a target path </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> url_path <br class="atl-forced-newline" /> </td>
<td> URL path </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> visibility <br class="atl-forced-newline" /> </td>
<td> Product visibility on the frontend </td>
</tr>
<tr>
<td> ArrayOfString <br class="atl-forced-newline" /> </td>
<td> category_ids <br class="atl-forced-newline" /> </td>
<td> Array of category IDs </td>
</tr>
<tr>
<td> ArrayOfString <br class="atl-forced-newline" /> </td>
<td> website_ids <br class="atl-forced-newline" /> </td>
<td> Array of website IDs </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> has_options <br class="atl-forced-newline" /> </td>
<td> Defines whether the product has options </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gift_message_available <br class="atl-forced-newline" /> </td>
<td> Defines whether the gift message is available for the product </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> price <br class="atl-forced-newline" /> </td>
<td> Product price </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> special_price <br class="atl-forced-newline" /> </td>
<td> Product special price </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> special_from_date <br class="atl-forced-newline" /> </td>
<td> Date starting from which the special price is applied to the product </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> special_to_date <br class="atl-forced-newline" /> </td>
<td> Date till which the special price is applied to the product </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> tax_class_id <br class="atl-forced-newline" /> </td>
<td> Tax class ID </td>
</tr>
<tr>
<td> array </td>
<td> tier_price <br class="atl-forced-newline" /> </td>
<td> Array of catalogProductTierPriceEntity </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> meta_title <br class="atl-forced-newline" /> </td>
<td> Mate title </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> meta_keyword <br class="atl-forced-newline" /> </td>
<td> Meta keyword </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> meta_description <br class="atl-forced-newline" /> </td>
<td> Meta description </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> custom_design <br class="atl-forced-newline" /> </td>
<td> Custom design </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> custom_layout_update <br class="atl-forced-newline" /> </td>
<td> Custom layout update </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> options_container <br class="atl-forced-newline" /> </td>
<td> Options container </td>
</tr>
<tr>
<td> associativeArray </td>
<td> additional_attributes <br class="atl-forced-newline" /> </td>
<td> Array of additional attributes </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> enable_googlecheckout <br class="atl-forced-newline" /> </td>
<td> Defines whether Google Checkout is applied to the product </td>
</tr>
</tbody></table>


<p>The <b>catalogProductTierPriceEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> customer_group_id <br class="atl-forced-newline" /> </td>
<td> ID of the customer group </td>
</tr>
<tr>
<td> string </td>
<td> website <br class="atl-forced-newline" /> </td>
<td> Website </td>
</tr>
<tr>
<td> int </td>
<td> qty <br class="atl-forced-newline" /> </td>
<td> Quantity to which the price will be applied </td>
</tr>
<tr>
<td> double </td>
<td> price <br class="atl-forced-newline" /> </td>
<td> Price that each item will cost </td>
</tr>
</tbody></table>


<h4><a name="catalog_product.info-Examples"></a>Examples</h4>

<h5><a name="catalog_product.info-RequestExampleSOAPV1"></a>Request Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$client = new SoapClient('http://magentohost/api/soap/?wsdl');

// If somestuff requires api authentification,
// then get a session token
$session = $client-&gt;login('apiUser', 'apiKey');

$result = $client-&gt;call($session, 'catalog_product.info', '4');
var_dump($result);

// If you don't need the session anymore
//$client-&gt;endSession($session);</pre>
		</div>
</div></div>

<h5><a name="catalog_product.info-RequestExampleSOAPV2"></a>Request Example SOAP V2</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
$sessionId = $proxy-&gt;login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary

$result = $proxy-&gt;catalogProductInfo($sessionId, '4');
var_dump($result);</pre>
		</div>
</div></div>


<h5><a name="catalog_product.info-RequestExampleSOAPV2%28WSIComplianceMode%29"></a>Request Example SOAP V2 (WS-I Compliance Mode)</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');

$sessionId = $proxy-&gt;login((object)array('username' =&gt; 'apiUser', 'apiKey' =&gt; 'apiKey'));

$result = $proxy-&gt;catalogProductInfo((object)array('sessionId' =&gt; $sessionId-&gt;result, 'productId' =&gt; '4'));
var_dump($result-&gt;result);</pre>
		</div>
</div></div>

<h5><a name="catalog_product.info-ResponseExampleSOAPV1"></a>Response Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: java; gutter: false">array
  'product_id' =&gt; string '4' (length=1)
  'sku' =&gt; string 'canon_powershot' (length=15)
  'set' =&gt; string '4' (length=1)
  'type' =&gt; string 'simple' (length=6)
  'categories' =&gt;
    array
      0 =&gt; string '3' (length=1)
      1 =&gt; string '5' (length=1)
  'websites' =&gt;
    array
      0 =&gt; string '2' (length=1)
  'type_id' =&gt; string 'simple' (length=6)
  'name' =&gt; string 'Canon PowerShot A630 8MP Digital Camera with 4x Optical Zoom' (length=60)
  'description' =&gt; string 'Replacing the highly popular PowerShot A620, the PowerShot A630 features a rotating 2.5-inch vari-angle LCD, 4x optical zoom lens, and a vast array of creative shooting modes.

The PowerShot A630 packs a vast array of advanced features into a remarkably compact space' (length=267)
  'short_description' =&gt; string 'Replacing the highly popular PowerShot A620, the PowerShot A630 features a rotating 2.5-inch vari-angle LCD, 4x optical zoom lens, and a vast array of creative shooting modes.' (length=175)
  'weight' =&gt; string '1.0000' (length=6)
  'old_id' =&gt; null
  'news_from_date' =&gt; null
  'news_to_date' =&gt; null
  'status' =&gt; string '1' (length=1)
  'url_key' =&gt; string 'canon-powershot-a630-8mp-digital-camera-with-4x-optical-zoom' (length=60)
  'url_path' =&gt; string 'canon-powershot-a630-8mp-digital-camera-with-4x-optical-zoom.html' (length=65)
  'visibility' =&gt; string '4' (length=1)
  'category_ids' =&gt;
    array
      0 =&gt; string '3' (length=1)
      1 =&gt; string '5' (length=1)
  'required_options' =&gt; string '0' (length=1)
  'has_options' =&gt; string '0' (length=1)
  'image_label' =&gt; null
  'small_image_label' =&gt; null
  'thumbnail_label' =&gt; null
  'created_at' =&gt; string '2012-03-29 12:47:56' (length=19)
  'updated_at' =&gt; string '2012-03-29 12:47:56' (length=19)
  'country_of_manufacture' =&gt; null
  'price' =&gt; string '329.9900' (length=8)
  'group_price' =&gt;
    array
      empty
  'special_price' =&gt; null
  'special_from_date' =&gt; null
  'special_to_date' =&gt; null
  'tier_price' =&gt;
    array
      empty
  'minimal_price' =&gt; null
  'msrp_enabled' =&gt; string '2' (length=1)
  'msrp_display_actual_price_type' =&gt; string '4' (length=1)
  'msrp' =&gt; null
  'enable_googlecheckout' =&gt; string '1' (length=1)
  'tax_class_id' =&gt; string '2' (length=1)
  'meta_title' =&gt; null
  'meta_keyword' =&gt; null
  'meta_description' =&gt; null
  'is_recurring' =&gt; string '0' (length=1)
  'recurring_profile' =&gt; null
  'custom_design' =&gt; null
  'custom_design_from' =&gt; null
  'custom_design_to' =&gt; null
  'custom_layout_update' =&gt; null
  'page_layout' =&gt; null
  'options_container' =&gt; string 'container2' (length=10)
  'gift_message_available' =&gt; null</pre>
		</div>
</div></div>

<?php include(__ROOT__ . 'footer.php'); ?>
